home *** CD-ROM | disk | FTP | other *** search
/ Aminet 15 / Aminet 15 - Nov 1996.iso / Aminet / util / misc / SplitIndex125.lha / SplitIndex.doc < prev    next >
Encoding:
Text File  |  1996-09-19  |  2.4 KB  |  81 lines
  1. SplitIndex.doc - Documentation for SplitIndex V1.25
  2. ===================================================
  3.  
  4. (29-Sep-96)
  5. ===========
  6.  
  7. Disclaimer:
  8. -----------
  9.  
  10. This program is freeware - copy/use it to your heart's content, but
  11. remember: if you use the SplitIndex and your computer explodes, you get
  12. invaded by martians, or any other unpleasant occurance befalls you, it's
  13. not my fault! :)
  14.  
  15. It seems to run properly, but...  (everyone repeat the mantra) "I use PD
  16. software at my own risk..."
  17.  
  18.  
  19. What Does It Do?
  20. ----------------
  21.  
  22. The program takes an aminet index file and splits it into several
  23. sub-indexes by aminet directory, i.e.  from your INDEX file, you create
  24. list.biz, list.comm, ...  list.util.  etc...  This is usefull for those of
  25. us without enough memory to have the whole index in a text reader at once.
  26.  
  27. This program was based on an AREXX script by Andreas Arleving which did
  28. exactly the same thing - So why did I make SplitIndex????
  29.  
  30. Well, Running Andreas's script took 1 hour and 40 minutes on my rather humble
  31. 68000 based 2000 - SplitIndex (being written in C) did it in about 4
  32. minutes. 
  33.  
  34.  
  35. Usage:
  36. ------
  37.  
  38. SplitIndex is CLI only - if it is run from WB, it will do nothing.  Command
  39. format is:
  40.  
  41. SplitIndex [SUB] <INDEXFILE> <OUTFILE>
  42.  
  43. Where <INDEXFILE> is the name of the aminet index to split and <OUTFILE> is
  44. the prefix for the sub indexes to be created, eg:
  45.  
  46. SplitIndex INDEX output/List
  47.  
  48. Typing 'SplitIndex ?' will list the command format and
  49.  
  50. SplitIndex SUB INDEX output/List
  51.  
  52. will split the index file by Aminet subdirectories rather than Aminet parent
  53. directories, to produce smaller output files.
  54.  
  55.  
  56. History:
  57. --------
  58. V1.0    Initial release.
  59.  
  60. V1.2    Added SUB keyword which splits the index up by aminet 
  61.         directory + subdirectory for even smaller output files.
  62.  
  63. V1.25   Modified the program to handle the full-length aminet indexes which 
  64.         are found in aminet/info/index.  I had just assumed that INDEX files
  65.         were always 80 characters wide, and this was hard coded into the 
  66.         program.  Thanks to Matteo Taveggia, for pointing out that this
  67.         wasn't the case  8-)
  68.  
  69.  
  70. Personal Notes:
  71. ---------------
  72.  
  73. * Thanks to Andreas Arleving for releasing his AREXX script to Aminet - my
  74. program is based largely on his script.
  75.  
  76. * Comments, criticisms, suggestions and bug reports would be very much
  77. appreciated.
  78.  
  79. email:          peter.ashford@stonebow.otago.ac.nz
  80. snail mail:     c/- 115 Glenpark Ave, Dunedin, New Zealand.
  81.